GH-138465: Improve documentation for common sequence methods #138474
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AA-Turner
requested review from
rhettinger,
willingc and
hugovk
as code owners
AA-Turner
added
needs backport to 3.13
Co-authored-by: Serhiy Storchaka <[email protected]>
| Mutable sequences should provide methods :meth:`~sequence.append`, | ||
| :meth:`~sequence.count`, :meth:`~sequence.index`, :meth:`~sequence.extend`, | ||
| :meth:`~sequence.insert`, :meth:`~sequence.pop`, :meth:`~sequence.remove`, | ||
| :meth:`~sequence.reverse` and :meth:`~sequence.sort`, |
There was a problem hiding this comment.
sequence.sort does not exist. But sequence.clear was omitted.
There was a problem hiding this comment.
This is unchanged text (the only difference is fixed cross-references). Please could we leave it to a different issue to change, if needed?
|
Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Sep 5, 2025
…ythonGH-138474) (cherry picked from commit 8ed1d53) Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Serhiy Storchaka <[email protected]>
|
Sorry, @AA-Turner, I could not cleanly backport this to |
|
GH-138560 is a backport of this pull request to the 3.14 branch. |
AA-Turner
added a commit
to AA-Turner/cpython
that referenced
this pull request
Sep 5, 2025
…hods (pythonGH-138474) (cherry picked from commit 8ed1d53) Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Serhiy Storchaka <[email protected]>
|
GH-138567 is a backport of this pull request to the 3.13 branch. |
AA-Turner
added a commit
that referenced
this pull request
Sep 5, 2025
…H-138474) (#138567) Co-authored-by: Serhiy Storchaka <[email protected]>
hugovk
pushed a commit
that referenced
this pull request
Sep 6, 2025
…H-138474) (#138560) GH-138465: Improve documentation for common sequence methods (GH-138474) (cherry picked from commit 8ed1d53) Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Serhiy Storchaka <[email protected]>
kumaraditya303
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Sep 9, 2025
…hods (pythonGH-138474) (python#138560) pythonGH-138465: Improve documentation for common sequence methods (pythonGH-138474) (cherry picked from commit 8ed1d53) Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Serhiy Storchaka <[email protected]>
lkollar
pushed a commit
to lkollar/cpython
that referenced
this pull request
Sep 9, 2025
…ython#138474) Co-authored-by: Serhiy Storchaka <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
cc @serhiy-storchaka
As part of this I've gone through the rest of the documentation and updated cross-references to use
sequence.{method}/list.{method}etc as appropriate.A
📚 Documentation preview 📚: https://cpython-previews--138474.org.readthedocs.build/